|
1
|
|
|
/* |
|
2
|
|
|
* helpers: functions to work with bytes and byte arrays. |
|
3
|
|
|
* Copyright (c) 2017 Rafael da Silva Rocha. |
|
4
|
|
|
* https://github.com/rochars/byte-data |
|
5
|
|
|
*/ |
|
6
|
|
|
|
|
7
|
|
|
const endianness = require("endianness"); |
|
8
|
|
|
const Type = require("../src/type"); |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* Padding for binary strings. |
|
12
|
|
|
* @param {!Array<string>} bytes The bytes as binary strings. |
|
13
|
|
|
* @param {number} base The base. |
|
14
|
|
|
* @param {number} index The byte to pad. |
|
15
|
|
|
*/ |
|
16
|
|
|
function padding(bytes, base, index) { |
|
17
|
|
|
bytes[index] = bytePadding(bytes[index], base); |
|
18
|
|
|
} |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* Padding with 0s for byte strings. |
|
22
|
|
|
* @param {string} theByte The byte as a binary or hex string. |
|
23
|
|
|
* @param {number} base The base. |
|
24
|
|
|
* @returns {string} The padded byte. |
|
25
|
|
|
*/ |
|
26
|
|
|
function bytePadding(theByte, base) { |
|
27
|
|
|
let offset = theByte.length + 1; |
|
28
|
|
|
if (base == 2) { |
|
29
|
|
|
offset = 8; |
|
30
|
|
|
} else if (base == 16) { |
|
31
|
|
|
offset = 2; |
|
32
|
|
|
} |
|
33
|
|
|
return lPadZeros(theByte, offset); |
|
34
|
|
|
} |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* Fix the size of nibbles. |
|
38
|
|
|
* @param {!Array<string>} nibbles The nibble as a binary or hex string. |
|
39
|
|
|
* @param {number} base The base. |
|
40
|
|
|
* @param {number} index The nibble offset. |
|
41
|
|
|
*/ |
|
42
|
|
|
function paddingNibble(nibbles, base, index) { |
|
43
|
|
|
if (base == 2 && nibbles[index].length < 4) { |
|
44
|
|
|
nibbles[index] = |
|
45
|
|
|
new Array((5 - nibbles[index].length)).join("0") + nibbles[index]; |
|
46
|
|
|
} |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
50
|
|
|
* Fix the size of crumbs. |
|
51
|
|
|
* @param {!Array<string>} crumbs The nibble as a binary or hex string. |
|
52
|
|
|
* @param {number} base The base. |
|
53
|
|
|
* @param {number} index The nibble offset. |
|
54
|
|
|
*/ |
|
55
|
|
|
function paddingCrumb(crumbs, base, index) { |
|
56
|
|
|
if ((base == 2 || base == 16) && crumbs[index].length < 2) { |
|
57
|
|
|
crumbs[index] = '0' + crumbs[index]; |
|
58
|
|
|
} |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* Pad a string with zeros to the left. |
|
63
|
|
|
* TODO: This should support both arrays and strings. |
|
64
|
|
|
* @param {string} value The string (representing a binary or hex value). |
|
65
|
|
|
* @param {number} numZeros the max number of zeros. |
|
66
|
|
|
* For 1 binary byte string it should be 8. |
|
67
|
|
|
*/ |
|
68
|
|
|
function lPadZeros(value, numZeros) { |
|
69
|
|
|
while (value.length < numZeros) { |
|
70
|
|
|
value = '0' + value; |
|
71
|
|
|
} |
|
72
|
|
|
return value; |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
/** |
|
76
|
|
|
* Swap the endianness to big endian. |
|
77
|
|
|
* @param {!Array<number>} bytes The values. |
|
78
|
|
|
* @param {Object} type The type. |
|
79
|
|
|
*/ |
|
80
|
|
|
function makeBigEndian(bytes, type) { |
|
81
|
|
|
if (type.be) { |
|
82
|
|
|
endianness(bytes, type.offset); |
|
83
|
|
|
} |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* Turn bytes to base 2, 10 or 16. |
|
88
|
|
|
* @param {!Array<string>|!Array<number>} bytes The bytes. |
|
89
|
|
|
* @param {number} base The base. |
|
90
|
|
|
* @param {Function} padFunction The function to use for padding. |
|
91
|
|
|
*/ |
|
92
|
|
|
function bytesToBase(bytes, base, padFunction=padding) { |
|
93
|
|
|
if (base != 10) { |
|
94
|
|
|
let i = 0; |
|
95
|
|
|
let len = bytes.length; |
|
96
|
|
|
while (i < len) { |
|
97
|
|
|
bytes[i] = bytes[i].toString(base); |
|
98
|
|
|
padFunction(bytes, base, i); |
|
99
|
|
|
i++; |
|
100
|
|
|
} |
|
101
|
|
|
} |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* Turn the output to the correct base. |
|
106
|
|
|
* @param {!Array<number>} bytes The bytes. |
|
107
|
|
|
* @param {number} bitDepth The bit depth of the data. |
|
108
|
|
|
* @param {number} base The desired base for the output data. |
|
109
|
|
|
*/ |
|
110
|
|
|
function outputToBase(bytes, bitDepth, base) { |
|
111
|
|
|
if (bitDepth == 4) { |
|
112
|
|
|
bytesToBase(bytes, base, paddingNibble); |
|
113
|
|
|
} else if (bitDepth == 2) { |
|
114
|
|
|
bytesToBase(bytes, base, paddingCrumb); |
|
115
|
|
|
} else if(bitDepth == 1) { |
|
116
|
|
|
bytesToBase(bytes, base, function(){}); |
|
117
|
|
|
}else { |
|
118
|
|
|
bytesToBase(bytes, base); |
|
119
|
|
|
} |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
/** |
|
123
|
|
|
* Fix the endianness of float16 bytes (r/w is always big-endian). |
|
124
|
|
|
* @param {!Array<number>|Uint8Array} bytes The bytes. |
|
125
|
|
|
* @param {Object} options The type. |
|
126
|
|
|
*/ |
|
127
|
|
|
function fixFloat16Endianness(bytes, options) { |
|
128
|
|
|
if (options.float && options.bits == 16) { |
|
129
|
|
|
endianness(bytes, 2); |
|
130
|
|
|
} |
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
|
|
/** |
|
134
|
|
|
* Get the full type spec for the reading/writing. |
|
135
|
|
|
* @param {Object} atype One of the available types. |
|
136
|
|
|
* @param {number} base The base of the input. |
|
137
|
|
|
* @param {boolean} single True if its a single value, false for array. |
|
138
|
|
|
* @return {Object} |
|
139
|
|
|
*/ |
|
140
|
|
|
function getType(atype, base, single) { |
|
141
|
|
|
let theType = Object.assign(new Type({}), atype); |
|
142
|
|
|
theType.base = base; |
|
143
|
|
|
theType.single = single; |
|
144
|
|
|
return theType; |
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
|
|
/** |
|
148
|
|
|
* Make a single value an array in case it is not. |
|
149
|
|
|
* If the value is a string it stays a string. |
|
150
|
|
|
* @param {!Array<number>|number|string} values The value or values. |
|
151
|
|
|
* @return {!Array<number>|string} |
|
152
|
|
|
*/ |
|
153
|
|
|
function turnToArray(values) { |
|
154
|
|
|
if (!Array.isArray(values) && typeof values != "string") { |
|
155
|
|
|
values = [values]; |
|
156
|
|
|
} |
|
157
|
|
|
return values; |
|
158
|
|
|
} |
|
159
|
|
|
|
|
160
|
|
|
module.exports.makeBigEndian = makeBigEndian; |
|
161
|
|
|
module.exports.bytesToBase = bytesToBase; |
|
162
|
|
|
module.exports.outputToBase = outputToBase; |
|
163
|
|
|
module.exports.padding = padding; |
|
164
|
|
|
module.exports.paddingNibble = paddingNibble; |
|
165
|
|
|
module.exports.paddingCrumb = paddingCrumb; |
|
166
|
|
|
module.exports.bytePadding = bytePadding; |
|
167
|
|
|
module.exports.lPadZeros = lPadZeros; |
|
168
|
|
|
module.exports.fixFloat16Endianness = fixFloat16Endianness; |
|
169
|
|
|
module.exports.getType = getType; |
|
170
|
|
|
module.exports.turnToArray = turnToArray; |
|
171
|
|
|
|
rochars /
byte-data
